CygNet Studio > Using CygNet Filter Rules > Filter Attributes > Point Service Attributes

Filter Attributes - Point Attributes

The following filter attributes represents properties from the point configuration record. They are available for use throughout CygNet Software.

Point: General

See PNT Editor - General Page for more information.

Attribute Attribute Name Description User Values

Active Status

activestatus

This attribute is used for filtering on the status of the point.

0 (no) or 1 (yes)

Allowed Updates

allowedupdates

This attribute is used for filtering on the setting of update values for the alarm.

B (Update All)

T (Internal /External)

C (Internal User)

I (Internal)

X (External User)

E (External)

U (User)

N (Updates None)

Allowed Updates Description

allowedupdates_desc

This attribute is used for filtering on a description of the Allowed Updates; for example, "Update All"

Text

Calc Parameter Error Exists

calcparmerror

This attribute is used for filtering on the alarm that has a calculation parameter error. A calc parm error is set by the PNT if the point contains invalid calculation parameters.

0 or 1

Comment

comment

This attribute is used for filtering a comment included in the alarm record. Check spelling; when possible, use the wildcard *.

Text

Display Attribute

displayattribute

This attribute is used for filtering on the display attribute for the alarm condition.

Text

Display Attribute Desc

displayattribute_desc

This attribute is used for filtering on the display attribute description for the alarm

Text

Facility ID

facilityid

This attribute is used for filtering on the Facility ID of the alarm.

Alphanumeric

Full Tag

tagfull

This attribute is used for filtering on the full tag of the alarm; for example, SITE.SERVICE.POINTID:LONGID.

Alphanumeric

General Point Config Error Exists

generalconfigerror

Attribute is used if a general point configuration error exists in the alarm. A general config error is set by the PNT for a variety of reasons, for example:

  • if the primary and secondary units are not convertible
  • if there are invalid entries configured for History reporting settings

0 or 1

GNS ID Entry Error Exists

gnsidentryerror

This attribute is used for filtering on a GNS ID entry that is in error for the alarm. This option can be useful for troubleshooting. For instance, you can filter to show those alarms that have a problem with a GNS ID.

A GNS ID entry error is set by the PNT if a GNS ID is configured on a point which does not exist in the GNS.

0 or 1

Initial Type

initialtype

This attribute is used for filtering on the initial type for the alarm when it is accessed (for example, (R)estored from the persist file or (I)nitialized.)

Text

Initial Type Desc

initialtype_desc

This attribute is used for filtering on a text description of the initial type.

None, Restore, Service Configuration, Specified Value

Initial Value

initialvalue

This attribute is used for filtering on the initial value for the alarm.

Alphanumeric

Key Field Entry Error Exists

keyfieldentryerror

This attribute is used for filtering on a key field entry error that exists in the point’s alarm condition. A key field entry error is set by the PNT if a referenced point does not exist. Does not apply to the OPCIS.

0 or 1

Long Description

longdescription

This attribute is used for filtering on the long description of the alarm.

Text

Long Point ID

pointidlong

This attribute is used for filtering on the long point ID of the alarm, i.e., Facility_UDC, for example, METER04_LTANK.

Alphanumeric

Long Tag

taglong

This attribute is used for filtering on the long tag of the point’s alarm condition, which would be SITE.SERVICE:FacilityID_UDC.

Alphanumeric

Manual Input Enabled

manualinputenabled

This attribute is used for filtering on whether or not manual input is enabled for the alarm.

0 (no) or 1 (yes)

Point Data Type

pointdatatype

This attribute is used for filtering on the point data type for the alarm (for example, AI for Analog Input, AO for Analog Output, DO for Digital Output, etc.)

AI, AO, DI, DO, EI, EO, SI, SO

Point Data Type Desc

pointdatatype_desc

This attribute is used for filtering on the description of the point data type for the alarm (for example, Analog Input, Digital Output, etc.)

Text

Point Has Comment

hascomment

This attribute is used for filtering on the alarm that has a comment.

0 or 1

Point ID

pointid

This attribute is used for filtering on the alarm’s short point ID (for example, 8 characters, such as 00000255).

Numeric

Point Scheme

pointscheme

This attribute is used for filtering on the point scheme used for describing point states and alarm conditions. The CygNet Standard Point Scheme is 0.

0 (or user-customized)

Point Scheme Description

pointschemedesc

This attribute is used for filtering on the name of the global point scheme for an alarm. The default is CygNet Standard.

CygNet Standard (or user-customized)

Security Application

securityapp

This attribute is used for filtering on the security application for the alarm.

Text

Service

service

This attribute is used for filtering on the service for the alarm, for example, UIS, SVCMON, OPCIS.

Text

Site

site

This attribute is used for filtering on the site for the alarm.

Text

SiteService

siteservice

This attribute is used for filtering on the Site.Service for the alarm.

Text

Spare

spare

This attribute is used for filtering on an attribute internal to the CygNet application.

Text

System Desc

system_desc

This attribute is used for filtering on the System description for an alarm.

Text

System Name

systemname

This attribute is used for filtering on the System name for an alarm.

Text

Tag

tag

This attribute is used for filtering on the tag for the point; for example, Site.Service.PointID.

Text (alphanumeric)

Uniform Data Code

uniformdatacode

This attribute is used for filtering on the uniform data code (UDC) for an alarm.

Text (alphanumeric)

Uniform Data Code Desc

uniformdatacode_desc

This attribute is used for filtering on the point’s UDC description for an alarm.

Text

Back to top

Point: History

See PNT Editor - History Page for more information.

Attribute Attribute Name Description User Values

Compression Deviation

compressiondeviation

This attribute is used for filtering on the Compression Deviation option.

Note: This attribute is an alias which will be used instead of History Deadband.

Numeric

Compression Type

compressiontype

This attribute is used for filtering on the Compression Type option.

Text

Force Current Value

forcecurrentval

This attribute is used for filtering on the Action: Force current value option.

Note: This attribute is an alias which will be used instead of Force History.

Text

Force Evaluation on Update

forceevaluationonupdate

This attribute is used for filtering on the Force evaluation on update without changed value option.

Note: This attribute is an alias which will be used instead of Force History On Update.

0 or 1

Force History

forcehistory

Obsolete. This attribute is used for filtering on the Force Logging option. This attribute is shown for backwards compatibility.

See Force Current Value for new alias value.

0 or 1

Force History On Update

forcehistoryonupdate

Obsolete. This attribute is used for filtering on a reporting history option. This attribute is shown for backwards compatibility.

See Force Evaluation on Update for new alias value.

0 or 1

Force Period

forceperiod

Obsolete. This attribute is used for filtering on a history range for the force history update. This attribute is shown for backwards compatibility.

See Maximum Reporting Interval for new alias value.

Numeric

History On Line Days

historyonlinedays

Obsolete. This attribute is used for filtering on a VHS point history option. This attribute is shown for backwards compatibility.

See Keep Values Within Days for new alias value.

Numeric

Keep Values Within Days

keepvaluewithindays

This attribute is used for filtering on the Keep values within last <n> days option (for example, 30).

Note: This attribute is an alias which will be used instead of History On Line Days.

Numeric

Maximum Reporting Interval

maximumreportinginterval

This attribute is used for filtering on the Maximum reporting interval <n> minutes option.

Note: This attribute is an alias which will be used instead of Force Period.

Numeric

Minimum Evaluation Time

minimumevaluationtime

This attribute is used for filtering on the Minimum evaluation time <n> seconds option.

0 or 1

Report on Next Update

reportonnext

This attribute is used for filtering on the Action: Report next value option.

Text

Report VHS

reportvhs

This attribute is used for filtering on the Report values to history option.

0 or 1

Back to top

Point: Point Reference

See PNT Editor - Point Reference Page for more information.

Attribute Attribute Name Description User Values

External ID

externalid

This attribute is used for filtering on the External ID for the alarm.

Numeric

External ID Type

externalidtype

This attribute is used for filtering on the External ID type for the alarm.

Alphanumeric

External ID Type Desc

externalidtype_desc

This attribute is used for filtering on the External ID type description for the alarm.

Text

Point Has External ID

hasexternalid

This attribute is used for filtering on an alarm with an External ID field filled in (PNT).

0 or 1

Point Reference Type

pointreferencetype

This attribute is used for filtering on a table-driven field that describes the function of an alarm’s point tag reference.

Numeric

Point Reference Type Desc

pointreferencetype_desc

This attribute is used for filtering on the description of the point reference type for an alarm.

Text

Reference Long Point ID

referencepointidlong

This attribute is used for filtering on the long point ID for the alarm that is application specific and is used by scripts and SVCMON and OPCIS.

Alphanumeric

Reference Point ID

referencepointid

This attribute is used for filtering on the reference point ID for the point that is application specific (used by scripts and SVCMON and OPCIS).

Numeric

Reference Service

referenceservice

This attribute is used for filtering on the reference service for the alarm that is application specific (used by scripts, SVCMON and OPCIS.)

Text

Reference Site

referencesite

This attribute is used for filtering on the reference site for the alarm that is application specific (used by scripts, SVCMON and OPCIS).

Text

Back to top

Point: Application

See PNT Editor - Application Page for more information.

Attribute Attribute Name Description User Values

Any User Flag Set

anyuserflag

This attribute is used for filtering on an alarm that has an internal user flag set.

0 or 1

Any Verified Flag Set

anyverifiedflag

This attribute is used for filtering on an alarm that has an internal verified flag set.

0 or 1

General 1-3

general1

general2

general3

This attribute is used for filtering on a user-defined attribute from the alarm’s application record.

Text

Indexed 1-3

indexed1

indexed2

indexed3

This attribute is used for filtering on the user-defined attribute from the PNT record for the alarm.

Text

Last Questionable Change Timestamp

questtimestamp

This attribute is used for filtering on the last timestamp indicating when there was a questionable change for the alarm. See Timestamps in the Data section for more information.

Numeric

Last Verified Change Timestamp

verifiedtimestamp

This attribute is used for filtering on the last verified timestamp change for the alarm. See Timestamps in the Data section for more information.

Numeric

Questionable Flag

questionableflag

This attribute is used for filtering on a user-defined flag in the alarm.

0 or 1

Table Driven 1-3

tabledriven1

tabledriven2

tabledriven3

This attribute is used for filtering on a user-defined attribute from the PNT record for an alarm.

Text

Table Driven 1-3 Desc

tabledriven1_desc

tabledriven2_desc

tabledriven3_desc

This attribute is used for filtering on user-defined attribute description from the PNT record for an alarm.

Text

User Flag 1-8

userflag1

userflag2

userflag3

.

.

userflag8

This attribute is used for filtering on a general user-defined attribute from the PNT record for the alarm.

0 or 1

Verified Flag 1-4

verifiedflag1

verifiedflag2

verifiedflag3

verifiedflag4

This attribute is used for filtering on a user-defined attribute from the PNT record for the alarm.

0 or 1

Back to top

Point: Alarm (PNT)

See the appropriate PNT Editor page (Analog, Digital, Enumeration, String) for more information.

Attribute Attribute Name Description User Values

Alarm Category

alarmcategory

This attribute is used for filtering on the alarm category of the point’s alarm (PNT only).

Alphanumeric

Alarm Category Description

alarmcategory_desc

This attribute is used for filtering on the description of the alarm category that matches the alarm category table entry. Make sure that the spelling, including capitalization, is correct (PNT only).

Text

Alarm Deadband

alarmdeadband

This attribute is used for filtering on a point having an alarm deadband entry (for example, 5, 10, etc.). (PNT).

Numeric

Configurable Bit 01-15 Alarm Priority

alarm01priority

alarm02priority

alarm03priority

.

.

.

alarm15priority

This attribute is used for filtering on an alarm’s numeric alarm priority (PNT).

0-99

Configurable Bit 01-15 Calc Parm 1

cfgbit01calcparm1

cfgbit02calcparm1

cfgbit03calcparm1

.

.

.

cfgbit15calcparm1

This attribute is used for filtering on a Calculation Parameter 1 for the alarm condition (PNT).

0 or 1

Configurable Bit 01-15 Calc Parm 2

cfgbit01calcparm2

cfgbit02calcparm2

cfgbit03calcparm2

.

.

.

cfgbit15calcparm2

This attribute is used for filtering on the Calculation Parameter 2 for the alarm condition (PNT).

0 or 1

Configurable Bit 01-15 Enabled

cfgbit01enabled

cfgbit02enabled

cfgbit03enabled

.

.

.

cfgbit15enabled

This attribute is used for filtering on an alarm with a specific alarm bit enabled (PNT).

0 or 1

Configurable Bit 01-15 GNS ID

cfgbit01gnsid

cfgbit02gnsid

cfgbit03gnsid

.

.

.

cfgbit15gnsid

This attribute is used for filtering on an alarm with a GNS ID (PNT).

Alphanumeric

Configurable Bit 01-15 Report CAS

cfgbit01reportcas

cfgbit02reportcas

cfgbit03reportcas

.

.

.

cfgbit15reportcas

This attribute is used for filtering on an alarm, which has a bit set to report to the CAS (PNT).

0 or 1

Configurable Bit 01-15 Report GNS

cfgbit01reportgns

cfgbit02reportgns

cfgbit03reportgns

.

.

.

cfgbit15reportgns

This attribute is used for filtering on an alarm, which has a configurable bit set to report to the GNS (PNT).

0 or 1

Configurable Bit 01-15 Reporting Delay

cfgbit01rptdelay

cfgbit02rptdelay

cfgbit02rptdelay

.

.

.

cfgbit15rptdelay

This attribute is used for filtering on the alarm, which has a Reporting Delay bit set (PNT).

0 or 1

Digital Off String

digitaloffstring

This attribute is used for filtering on a Digital OFF string set to Off for the alarm (PNT).

0 or 1

Digital ON String

digitalonstring

This attribute is used for filtering when the Digital ON string is set to ON for the alarm (PNT).

0 or 1

Does Any Config Bit have a GNS ID

anycfgbithasgnsid

This attribute is used for filtering on a configurable bit that has a GNS ID for the alarm (PNT).

0 or 1

Does Any Config Bit have Rptg Delay

anycfgbithasrptdly

Attribute is for a configurable bit that has a Reporting Delay for the alarm (PNT).

0 or 1

Enum Table Name

enumtablename

This attribute is used for filtering on the enumeration alarm’s table name (PNT).

Text

History Deadband

historydeadband

This attribute is used for filtering on the History Deadband of the alarm.

Numeric

Is Any Config Bit Enabled

anycfgbitenabled

This attribute is used for filtering on a configurable bit enabled for the alarm (PNT only).

0 or 1

Is Any Config Bit Reporting to CAS

anycfgbitrptgcas

This attribute is used for filtering on a configurable bit reporting to the CAS (PNT only).

0 or 1

Is Any Config Bit Reporting to GNS

anycfgbitrptggns

This attribute is used for filtering on a configurable bit that is reporting to the GNS. (PNT only)

0 or 1

Maximum Setpoint

maxsetpoint

This attribute is used for filtering on the maximum setpoint for the alarm (PNT).

Numeric

Minimum Setpoint

minsetpoint

This attribute is used for filtering on the minimum setpoint for the alarm (PNT).

Numeric

Report Alarm Delay

reportalarmdelay

This attribute is used for filtering on alarm reporting delay to the CAS or to the GNS.

0 or 1

Report Delay Value Units

reportdelayunits

This attribute is used for filtering on the alarm’s delay value units.

Text

Report Delay Value Units Description

reportdelayunits_desc

This attribute is used for filtering on the description of the alarm’s delay value units.

Text

Suppress Alarms Enabled

suppressalarmsenabled

This attribute is used for filtering on whether an alarm condition is suppressed for the point (PNT).

0 or 1

Suppress Alarms End On Date/Time

suppressalarmsendondatetime

This attribute is used for filtering on Suppression for the point’s alarm condition that ends on a date and time (PNT).

0 or 1

Suppress Alarms End On Normal

suppressalarmsendonnormal

This attribute is used for filtering on Suppression for the point’s alarm condition that ends when the normal point state occurs (PNT).

0 or 1

Back to top

Point: Alarm (Scheme 0)

Attribute Attribute Name Description User Values

Alarm Deadband

alarmdeadband

This attribute is used for filtering on a point having an alarm deadband entry (for example, 5, 10, etc.). (PNT).

Numeric

Alarm Priority

alarmpriority

This attribute is used for filtering on the priority number for the alarm.

0-99

Digital Alarm Enabled

digitalalarmenabled

This attribute is used for filtering on whether a digital alarm is enabled.

0 or 1

Digital Alarm GNS ID

digitalalarmgnsid

This attribute is used for filtering on the GNS ID of a digital alarm.

Alphanumeric

Digital Alarm When Off

digitalalarmwhenoff

This attribute is used for filtering on whether the digital alarm calcparm 1 bit is set.

0 or 1

Digital OFF String

digitaloffstring

This attribute is used for filtering on a Digital OFF string set to Off for the alarm (PNT).

Text

Digital ON String

digitalonstring

This attribute is used for filtering when the Digital ON string is set to ON for the alarm (PNT).

Text

Enum Alarm 1 - 6 Enabled

enumalarm1enabled

enumalarm2enabled

enumalarm3enabled

enumalarm4enabled

enumalarm5enabled

enumalarm6enabled

This attribute is used for filtering on whether an enumeration alarm (1 - 6) is enabled.

0 or 1

Enum Alarm 1 - 6 GNS ID

enumalarm1gnsid

enumalarm2gnsid

enumalarm3gnsid

enumalarm4gnsid

enumalarm5gnsid

enumalarm6gnsid

This attribute is used for filtering on the GNS ID of an enumeration alarm (1 - 6).

Alphanumeric

Enum Alarm 1 - 6 Value

enumalarm1value

enumalarm2value

enumalarm3value

enumalarm4value

enumalarm5value

enumalarm6value

This attribute is used for filtering on the value of an enumeration alarm (1 - 6).

Alphanumeric

Enum Table Name

enumtablename

This attribute is used for filtering on the enumeration alarm’s table name (PNT).

Text

High Alarm Enabled

highalarmenabled

This attribute is used for filtering on whether a high alarm bit is enabled.

0 or 1

High Alarm GNS ID

highalarmgnsid

This attribute is used for filtering on the GNS ID of a high alarm.

Alphanumeric

High Alarm Value

highalarmvalue

This attribute is used for filtering on the value of a high alarm.

Alphanumeric

High Deviation Enabled

highdevenabled

This attribute is used for filtering on whether a high deviation alarm bit is enabled.

0 or 1

High Deviation GNS ID

highdevgnsid

This attribute is used for filtering on the GNS ID of a high deviation alarm.

Alphanumeric

High Deviation Value

highdevvalue

This attribute is used for filtering on the val

ue of a high deviation alarm.

Alphaumeric

High OOR Enabled

highoorenabled

This attribute is used for filtering on whether a high out-of-range alarm bit is enabled.

0 or 1

High OOR GNS ID

highoorgnsid

This attribute is used for filtering on the GNS ID of a high out-of-range alarm.

Alphanumeric

High OOR Value

highoorvalue

This attribute is used for filtering on the value of a high out-of-range alarm.

Alphanumeric

High Warning Enabled

highwarningenabled

This attribute is used for filtering on whether a high warning alarm bit is enabled.

0 or 1

High Warning GNS ID

highwarninggnsid

This attribute is used for filtering on the GNS ID of a high warning alarm.

Alphanumeric

High Warning Value

highwarningvalue

This attribute is used for filtering on the value of a high warning alarm.

Alphanumeric

History Deadband

historydeadband

This attribute is used for filtering on the History Deadband of the alarm.

Numeric

Low Alarm Enabled

lowalarmenabled

This attribute is used for filtering on whether a low alarm bit is enabled.

0 or 1

Low Alarm GNS ID

lowalarmgnsid

This attribute is used for filtering on the GNS ID of a low alarm.

Alphanumeric

Low Alarm Value

lowalarmvalue

This attribute is used for filtering on the value of a low alarm.

Alphanumeric

Low OOR Enabled

lowoorenabled

This attribute is used for filtering on whether a low out-of-range alarm bit is enabled.

0 or 1

Low OOR GNS ID

lowoorgnsid

This attribute is used for filtering on the GNS ID of a low out-of-range alarm.

Alphanumeric

Low OOR Value

lowoorvalue

This attribute is used for filtering on the value of a low out-of-range alarm.

Alphanumeric

Low Warning Enabled

lowwarningenabled

This attribute is used for filtering on whether a low warning alarm bit is enabled.

0 or 1

Low Warning GNS ID

lowwarninggnsid

This attribute is used for filtering on the GNS ID of a low warning alarm.

Alphanumeric

Low Warning Value

lowwarningvalue

This attribute is used for filtering on the value of a low warning alarm.

Alphanumeric

Maximum Setpoint

maxsetpoint

This attribute is used for filtering on the maximum

setpoint for the alarm (PNT).

Numeric

Minimum Setpoint

minsetpoint

This attribute is used for filtering on the Minimum setpoint for the alarm (PNT).

Numeric

Report Alarm Delay

reportalarmdelay

This attribute is used for filtering on alarm reporting delay to the CAS or to the GNS.

0 or 1

Report CAS

reportcas

This attribute is used for filtering on whether the alarm is reported to the CAS.

0 or 1

Report GNS

reportgns

This attribute is used for filtering on whether the alarm is reported to the GNS.

0 or 1

String Alarm 1 - 6 Enabled

stringalarm1enabled

stringalarm2enabled

stringalarm3enabled

stringalarm4enabled

stringalarm5enabled

stringalarm6enabled

This attribute is used for filtering on whether a string alarm (1 - 6) is enabled.

0 or 1

String Alarm 1 - 6 GNS ID

stringalarm1gnsid

stringalarm2gnsid

stringalarm3gnsid

stringalarm4gnsid

stringalarm5gnsid

stringalarm6gnsid

This attribute is used for filtering on the GNS ID of a string alarm (1 - 6).

Alphanumeric

String Alarm 1 - 6 Value

stringalarm1value

stringalarm2value

stringalarm3value

stringalarm4value

stringalarm5value

stringalarm6value

This attribute is used for filtering on the value of a string alarm (1 - 6).

Alphanumeric

Back to top

Point: Scaling

See PNT Editor - Scaling Page for more information.

Attribute Attribute Name Description User Values

Decimal Places

decimalplaces

This attribute is used for filtering on the number of decimal places that exist in Scaling portion of the alarm record. (Sixteen characters, including decimal digits, are allowed.)

Numeric

Decimal Places Flag

decimal

This attribute is used for filtering on an alarm that determines whether decimals are displayed.

0 or 1

High Engineering Value

enghigh

This attribute is used for scaling and filtering on the High Engineering value for the alarm.

Numeric

Low Engineering Value

englow

This attribute is used for scaling and filtering on the Low Engineering value for the alarm.

Numeric

Raw High

rawhigh

This attribute is used for filtering on the alarm’s raw high value used in linear scaling.

Numeric

Raw Low

rawlow

This attribute is used for filtering on the alarm’s raw low value used in linear scaling.

Numeric

Scale Coefficient a0-a5

scalecoef_a0

scalecoef_a1

scalecoef_a2

scalecoef_a3

scalecoef_a4

scalecoef_a5

This attribute is used for filtering on the scale coefficient number for the alarm when polynomial curve fit coefficients are used.

Numeric

Scale Value

scalevalue

This attribute is used for filtering on the scaling value of the alarm.

Numeric

Use Two Point Scaling

twopntscale

This attribute is used for filtering on the two-point scaling in use for the alarm.

Numeric

Back to top

Point: HyperPoint

See PNT Editor - HyperPoint Page for more information.

Attribute Attribute Name Description User Values

Hyper Point Library Long ID

hyperpointliblongid

This attribute is used for filtering on the Hyper Point Library Long ID for the alarm.

Alphanumeric

Hyper Point Script Format Description

hyperpointscriptfmt_desc

This attribute is used for filtering on the Hyper Point Script format description for the alarm.

Text

Hyper Point Script Format

hyperpointscriptfmt

This attribute is used for filtering on the Hyper Point Script format for the alarm.

Text

Hyper Point Type

hyperpointtype

This attribute is used for filtering on the Hyper Point type for the alarm; for instance, "S" for "script."

Text

Hyper Point Type Description

hyperpointtype_desc

This attribute is used for filtering on the Hyper Point type description for the alarm.

Text

HyperPoint Enabled

hyperpointenabled

This attribute is used for filtering on whether Hyper Point is enabled for the alarm.

0 or 1

Script Enabled

scriptenabled

This attribute is used for filtering on whether a script is enabled for the alarm.

0 or 1

Script Version

scriptversion

This attribute is used for filtering on the script version for the alarm.

Numeric

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.